feat(frontend): implement OAuth authentication #13151

Rossil2012 · 2023-10-30T10:04:31Z

I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.

What's changed and what's your intention?

Refer to #11440.

Support to authenticate with OAuth token acquired from cloud.

The basic workflow can be tested as follows:

# create a new user test with OAuth authentication
psql -h localhost -p 4566 -d dev -U root

# in psql
create user test with oauth (
  jwks_url = 'xxx.com',  // required
  issuer = 'risingwave',  // required
  other_params_should_match = 'xxx',  // optional, will be checked against jwt.claims
);

# password here is actually OAuth token, and would be passed with plaintext
psql -h localhost -p 4566 -d dev -U test

kid and alg are required in the header of JWT, and kid is also required in the JWKs returned by the JWKS server. All params set in user creation (except jwks_url) will be checked in the claims of jwt, any mismatch will deny the login process.

Checklist

I have written necessary rustdoc comments
I have added necessary unit tests and integration tests
I have added fuzzing tests or opened an issue to track them. (Optional, recommended for new SQL features Sqlsmith: Sql feature generation #7934).
My PR contains breaking changes. (If it deprecates some features, please create a tracking issue to remove them in the future).
All checks passed in ./risedev check (or alias, ./risedev c)
My PR changes performance-critical code. (Please run macro/micro-benchmarks and show the results.)

My PR contains critical fixes that are necessary to be merged into the latest release. (Please check out the details)

Documentation

My PR needs documentation updates. (Please use the Release note section below to summarize the impact on users)

Release note

If this PR includes changes that directly affect users or other significant modifications relevant to the community, kindly draft a release note to provide a concise summary of these changes. Please prioritize highlighting the impact these changes will have on users.

New sql syntax:

create/alter user test with oauth (
  jwks_url = 'xxx.com',  // required
  issuer = 'risingwave',  // required
  other_params_should_match = 'xxx',  // optional, will be checked against jwt.claims
);

Note that key in the options must be SMALL-CASED.

yezizp2012

LGTM, let's keep this PR and wait for the progress on the cloud side later.

src/utils/pgwire/src/pg_server.rs

github-actions · 2023-12-31T01:50:51Z

This PR has been open for 60 days with no activity. Could you please update the status? Feel free to ping a reviewer if you are waiting for review.

gitguardian · 2024-02-20T03:37:43Z

⚠️ GitGuardian has uncovered 3 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
9425213	Triggered	Generic Password	`169720c`	ci/scripts/e2e-source-test.sh	View secret
9425213	Triggered	Generic Password	`169720c`	ci/scripts/e2e-source-test.sh	View secret
9425213	Triggered	Generic Password	`169720c`	ci/scripts/regress-test.sh	View secret

🛠 Guidelines to remediate hardcoded secrets

Understand the implications of revoking this secret by investigating where it is used in your code.
Replace and store your secrets safely. Learn here the best practices.
Revoke and rotate these secrets.
If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

following these best practices for managing and storing secrets including API keys and other credentials
install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!}

yezizp2012

Rest LGTM.

src/common/src/system_param/mod.rs

src/utils/pgwire/src/pg_server.rs

proto/user.proto

src/frontend/src/session.rs

src/common/src/system_param/reader.rs

yezizp2012

Good Job! Have you tested it with @xuhui-lu ?

Rossil2012 · 2024-02-23T08:16:30Z

Good Job! Have you tested it with @xuhui-lu ?

Not yet. Waiting for @xuhui-lu to provide a test jwks server and jwt.

yezizp2012 · 2024-02-28T18:27:29Z

Hi @Rossil2012 , I resolved all comments and pushed some commits directly in this PR. Please help to verify if on your local setup. Let's merge it and cherry-pick to release 1.7 if it works.

Rossil2012 · 2024-02-29T01:27:19Z

Hi @Rossil2012 , I resolved all comments and pushed some commits directly in this PR. Please help to verify if on your local setup. Let's merge it and cherry-pick to release 1.7 if it works.

Wow, thank you! However, in order to support per-user oauth configuration, @xuhui-lu and I determined to add a new syntax like create user u with oauth (jwks_url = 'xxx', user_id = 'xxx'). This way we can enable a more flexible check on the claims decoded from jwt, and community users can build their own oauth authentication workflow by specifying static config in user creation and dynamically check them in jwt header. I will release the details in the introduction later. The system params will not be used then🤣.

proto/user.proto

src/utils/pgwire/src/pg_server.rs

stdrc · 2024-03-01T07:50:29Z

Hi @Rossil2012 , I resolved all comments and pushed some commits directly in this PR. Please help to verify if on your local setup. Let's merge it and cherry-pick to release 1.7 if it works.

Wow, thank you! However, in order to support per-user oauth configuration, @xuhui-lu and I determined to add a new syntax like create user u with oauth (jwks_url = 'xxx', user_id = 'xxx'). This way we can enable a more flexible check on the claims decoded from jwt, and community users can build their own oauth authentication workflow by specifying static config in user creation and dynamically check them in jwt header. I will release the details in the introduction later. The system params will not be used then🤣.

So IIUC the current implementation is not considered as a stable or final one, right? Is that so urgent that this should be released in 1.7? I would suggest to wait for 1.8 which IIRC will be frozen in recent days.

Rossil2012 · 2024-03-01T09:01:22Z

Hi @Rossil2012 , I resolved all comments and pushed some commits directly in this PR. Please help to verify if on your local setup. Let's merge it and cherry-pick to release 1.7 if it works.

Wow, thank you! However, in order to support per-user oauth configuration, @xuhui-lu and I determined to add a new syntax like create user u with oauth (jwks_url = 'xxx', user_id = 'xxx'). This way we can enable a more flexible check on the claims decoded from jwt, and community users can build their own oauth authentication workflow by specifying static config in user creation and dynamically check them in jwt header. I will release the details in the introduction later. The system params will not be used then🤣.

So IIUC the current implementation is not considered as a stable or final one, right? Is that so urgent that this should be released in 1.7? I would suggest to wait for 1.8 which IIRC will be frozen in recent days.

This feature may be urgent for cloud, cc @xuhui-lu.

xuhui-lu · 2024-03-01T09:04:13Z

Hi @Rossil2012 , I resolved all comments and pushed some commits directly in this PR. Please help to verify if on your local setup. Let's merge it and cherry-pick to release 1.7 if it works.

Wow, thank you! However, in order to support per-user oauth configuration, @xuhui-lu and I determined to add a new syntax like create user u with oauth (jwks_url = 'xxx', user_id = 'xxx'). This way we can enable a more flexible check on the claims decoded from jwt, and community users can build their own oauth authentication workflow by specifying static config in user creation and dynamically check them in jwt header. I will release the details in the introduction later. The system params will not be used then🤣.

So IIUC the current implementation is not considered as a stable or final one, right? Is that so urgent that this should be released in 1.7? I would suggest to wait for 1.8 which IIRC will be frozen in recent days.

This is related to a page revamp recently proposed by yingjun. We need this feature to remove the password for accessing cloud web console.

stdrc

Approve on behalf of Cargo-lock

pass oauth token with plaintext

5bd0ef7

Rossil2012 requested review from yezizp2012 and xuhui-lu October 30, 2023 10:04

github-actions bot added the type/feature label Oct 30, 2023

print oauth token for debug

1cc3d16

Rossil2012 changed the title ~~feat(user): implement OAuth authentication~~ feat(frontend): implement OAuth authentication Oct 30, 2023

yezizp2012 reviewed Oct 31, 2023

View reviewed changes

src/utils/pgwire/src/pg_server.rs Outdated Show resolved Hide resolved

github-actions bot added the no-pr-activity label Dec 31, 2023

Merge branch 'main' into kanzhen/rw-oauth

169720c

Rossil2012 removed the no-pr-activity label Feb 21, 2024

impl jwt auth

5d4bfe2

Rossil2012 requested a review from yezizp2012 February 21, 2024 11:27

Rossil2012 marked this pull request as ready for review February 22, 2024 01:02

Rossil2012 requested a review from a team as a code owner February 22, 2024 01:02

Merge branch 'main' into kanzhen/rw-oauth

29b74d2

yezizp2012 reviewed Feb 22, 2024

View reviewed changes

src/common/src/system_param/mod.rs Outdated Show resolved Hide resolved

src/utils/pgwire/src/pg_server.rs Outdated Show resolved Hide resolved

BugenZhao reviewed Feb 22, 2024

View reviewed changes

proto/user.proto Outdated Show resolved Hide resolved

Rossil2012 added 3 commits February 23, 2024 12:14

get_url on connect

106d5f8

use None as default

716400d

fix unit test

7eeef9f

yezizp2012 reviewed Feb 23, 2024

View reviewed changes

src/frontend/src/session.rs Outdated Show resolved Hide resolved

yezizp2012 reviewed Feb 23, 2024

View reviewed changes

src/common/src/system_param/reader.rs Outdated Show resolved Hide resolved

yezizp2012 reviewed Feb 23, 2024

View reviewed changes

yezizp2012 added 3 commits February 29, 2024 01:47

Merge branch 'main' into kanzhen/rw-oauth

0b85778

fix default and add validation

dc97f26

update doc

80e410b

fix e2e

e490f80

fix comments

9ce4fee

Rossil2012 added need-cherry-pick-release-1.7 user-facing-changes Contains changes that are visible to users labels Feb 29, 2024

minor fix

94d4462

Rossil2012 requested review from BugenZhao and yezizp2012 February 29, 2024 07:51

Merge branch 'main' into kanzhen/rw-oauth

bde884f

stdrc reviewed Mar 1, 2024

View reviewed changes

proto/user.proto Outdated Show resolved Hide resolved

src/utils/pgwire/src/pg_server.rs Outdated Show resolved Hide resolved

fix comments

b5bc317

Rossil2012 requested a review from stdrc March 1, 2024 12:16

yezizp2012 approved these changes Mar 4, 2024

View reviewed changes

Merge branch 'main' into kanzhen/rw-oauth

92c0529

Rossil2012 removed the user-facing-changes Contains changes that are visible to users label Mar 5, 2024

stdrc approved these changes Mar 5, 2024

View reviewed changes

Rossil2012 added this pull request to the merge queue Mar 5, 2024

Merged via the queue into main with commit 9966b81 Mar 5, 2024
28 of 30 checks passed

Rossil2012 deleted the kanzhen/rw-oauth branch March 5, 2024 03:46

github-actions bot mentioned this pull request Mar 5, 2024

cherrypick feat(frontend): implement OAuth authentication (#13151) to branch release-1.7 #15436

Closed

Rossil2012 added a commit that referenced this pull request Mar 5, 2024

feat(frontend): implement OAuth authentication (#13151)

be74d82

BugenZhao mentioned this pull request Apr 5, 2024

risingwave 1.8.0 risingwavelabs/homebrew-risingwave#34

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(frontend): implement OAuth authentication #13151

feat(frontend): implement OAuth authentication #13151

Rossil2012 commented Oct 30, 2023 •

edited

Loading

yezizp2012 left a comment

github-actions bot commented Dec 31, 2023

gitguardian bot commented Feb 20, 2024 •

edited

Loading

yezizp2012 left a comment

yezizp2012 left a comment

Rossil2012 commented Feb 23, 2024

yezizp2012 commented Feb 28, 2024

Rossil2012 commented Feb 29, 2024

stdrc commented Mar 1, 2024

Rossil2012 commented Mar 1, 2024

xuhui-lu commented Mar 1, 2024

stdrc left a comment

feat(frontend): implement OAuth authentication #13151

feat(frontend): implement OAuth authentication #13151

Conversation

Rossil2012 commented Oct 30, 2023 • edited Loading

What's changed and what's your intention?

Checklist

Documentation

Release note

yezizp2012 left a comment

Choose a reason for hiding this comment

github-actions bot commented Dec 31, 2023

gitguardian bot commented Feb 20, 2024 • edited Loading

⚠️ GitGuardian has uncovered 3 secrets following the scan of your pull request.

yezizp2012 left a comment

Choose a reason for hiding this comment

yezizp2012 left a comment

Choose a reason for hiding this comment

Rossil2012 commented Feb 23, 2024

yezizp2012 commented Feb 28, 2024

Rossil2012 commented Feb 29, 2024

stdrc commented Mar 1, 2024

Rossil2012 commented Mar 1, 2024

xuhui-lu commented Mar 1, 2024

stdrc left a comment

Choose a reason for hiding this comment

Rossil2012 commented Oct 30, 2023 •

edited

Loading

gitguardian bot commented Feb 20, 2024 •

edited

Loading